LEADTOOLS Forms (Leadtools.Forms.Auto assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
Run(Stream,List<IMasterFormsCategory>) Method
See Also 
Leadtools.Forms.Auto Namespace > AutoFormsEngine Class > Run Method : Run(Stream,List<IMasterFormsCategory>) Method



stream
A System.IO.Stream containing the the unknown form image data.
categories
List of Master Forms categories to use in comparison, pass null or empty to use all Master Forms in the repository.

The Run(Stream,List<IMasterFormsCategory>) Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

stream
A System.IO.Stream containing the the unknown form image data.
categories
List of Master Forms categories to use in comparison, pass null or empty to use all Master Forms in the repository.
Automatically recognizes the unknown form then it processes its fields.

Syntax

Visual Basic (Declaration) 
Overloads Public Function Run( _
   ByVal stream As Stream, _
   ByVal categories As List(Of IMasterFormsCategory) _
) As AutoFormsRunResult
Visual Basic (Usage)Copy Code
Dim instance As AutoFormsEngine
Dim stream As Stream
Dim categories As List(Of IMasterFormsCategory)
Dim value As AutoFormsRunResult
 
value = instance.Run(stream, categories)

Parameters

stream
A System.IO.Stream containing the the unknown form image data.
categories
List of Master Forms categories to use in comparison, pass null or empty to use all Master Forms in the repository.

Return Value

Returns the results of the recognition and processing if the form is recognized, otherwise it returns null. If the Master Form has no processing field, AutoFormsRunResult.FormFields will be null.

Example

Visual BasicCopy Code
Public Sub AutoFormRunStream()
      Dim root As String = Path.Combine(LEAD_VARS.ImagesDir, "Forms\FormsDemo\OCR_Test")

      Dim codecs_Renamed As RasterCodecs = New RasterCodecs()
      'create repository
      Dim repository As DiskMasterFormsRepository = New DiskMasterFormsRepository(codecs_Renamed, root)

      Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False)
         ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)
         Dim engineBarcode As BarcodeEngine = New BarcodeEngine()

         'create AutoForm Engine
         Dim autoEngine As AutoFormsEngine = New AutoFormsEngine(repository, ocrEngine, engineBarcode, AutoFormsRecognitionManager.Ocr Or AutoFormsRecognitionManager.Default, 30, 80, True)

         Dim fs As FileStream = File.OpenRead(Path.Combine(LEAD_VARS.ImagesDir, "Forms\Images\FCC-107_OCR_Filled.tif"))

         'recognize and process the form
         Dim result As AutoFormsRunResult = autoEngine.Run(fs, Nothing)
         If result Is Nothing Then
            Return
         End If
      End Using
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
public void AutoFormRunStream()
   {
      string root = Path.Combine(LEAD_VARS.ImagesDir, @"Forms\FormsDemo\OCR_Test");
      RasterCodecs codecs = new RasterCodecs();
      //create repository
      DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root);

      using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false))
      {
         ocrEngine.Startup(null, null, null, null);
         BarcodeEngine barcodeEngine = new BarcodeEngine();

         //create AutoForm Engine
         AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine, AutoFormsRecognitionManager.Ocr | AutoFormsRecognitionManager.Default, 30, 80, true);

         FileStream fs = File.OpenRead(Path.Combine(LEAD_VARS.ImagesDir, @"Forms\Images\FCC-107_OCR_Filled.tif")); 

         //recognize and process the form
         AutoFormsRunResult result = autoEngine.Run(fs, null);
         if(result == null)
            return;
      }
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Remarks

This method automatically recognizes the unknown form and process its fields at the same time.

The stream should have all form pages.

If RecognizeFirstPageOnly is true, the recognition will be performed based on the first page only, if it is false the recognition will be performed over all the form pages.

If the form is not recognized it will return null, if the Master Form of the form type has no field then AutoFormsRunResult.FormFields will be null.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Forms requires a Forms Module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features